OpenPlant Modeler Help

Consistency Manager - Settings

The Settings tab of the Consistency Manager allow you to define detailed settings to control what information is displayed and how it is formatted under the Home tab.

Classes

The Classes section control what classes are displayed in the Query Class Navigator. You can expand and use the checkboxes to determine what classes to hide or display.

Use the options to on the right to control the display of the Classes sectionCheck, Uncheck, Expand All and Collapse All the class tree

If the Current Selection checkbox is enabled, then these options apply only to the selected node. For example, if the Equipment node is selected and you select Expand All, only the Equipment node, and all nodes underneath that node will be expanded.

Mapping

This section lets you edit the "MappingsTagClass" section. This contains the mapping classes for Tag Browsing and Placement. The class mapping is divided into two sections, 2D Classes and 3D Classes. Each Class has Mapped properties. These properties allow for the class polymorphism (inheritance), allowing or disabling Browsing and Tag Browsing/Placement target mapping.

To add a mapping, select Add to display the following dialog. Only classes that are in the current application schema and not in the mapped classes will show. Use the Filter button to narrow down the selection.

To add a target mapping, select Add to display the following dialog. Only classes that are in the current base schema and not in the mapped target classes will show. Use the Filter button to narrow down the selection.

Properties

The Properties section lets you determine which properties are Excluded or Included when comparing component values between the 2D and 3D. Properties can be Included/Excluded using by selecting the property and using the arrow buttons.

Compare

The Compare section provides criteria which can be set when comparing properties.
  • Show items that match and have an empty value: Recommended to leave unchecked so properties with no value will not display.
  • Trim Properties Values: If property values have leading and/or trailing spaces, these will be trimmed before comparing the values.
  • Ignore Case: Will ignore the text case when comparing property values.
  • Ignore Question Marks (?): Any items with a question mark will be ignored and not shown when checked.
  • Prompt for Property Change Commit: When enabled, you will be prompted to commit any changes to property values. Otherwise the changes are committed automatically.

Reports

The Backstage provides report options which can be defined for each type of report. A standard set of report configuration options are available as well.
SettingDescription
Consistency Report Options These are default options which apply to all report types:
  • User Directory:
    • Defines default folder to write reports to.
    • Common to all report types.
    • If this value in individual report type is blank, this value will be used.
    • If this value is blank, the current dgn location is used.
  • File Name Base
    • The name of the report file.
    • Common to all report types but can be overridden by the individual report type values.
    • If this value is blank in a report type, this value will be used.
    • if this value is blank a default of "ConsistencyReport" will be used.
Report Type Options Each report type (HTML, JSON, TEXT, XML) has a list of options which can be set to override the default report options:
  • User Directory:
    • Defines folder to write the report to.
    • This value overrides the default folder.
    • If bland, the default folder is used.
  • File Name Base:
    • The name of the report file
    • This value overrides the default name.
    • If blank, the default name is used.
  • Show in Ribbon:
    • Shows the report type in the main ribbon. HTML and TXT are the default which are displayed.
  • Show in Menu:
    • Shows the report type in the right click menu in the Instances tree.
  • Html Difference Table Style (HTML Report Only)
    • This value is used to format the differences table.

Display

These are display options which are applied to the Tags listed in the Instances Tree. There are
SettingDescription
Common options The following common options apply to the whole Instances tree:
Document The following options apply to documents:
Not Placed The following options apply to items not placed in either a 2D or 3D drawing:
Parent The following options apply to parent classes:
Placed in 2D The following options apply to items placed in a 2D drawing:
Placed in 3D The following options apply to items placed in a 3D drawing:
Placed in 2D and 3D The following options apply to items placed in both 2D and 3D drawings:
Property Differences The following options apply to items which have property differences between 2D and 3D drawings:
WBS The following options apply to Work Breakdown System items:

Messages

Displays messages from actions taken in the Consistency Manager:

Legend

Click this option to display a legend of the symbols used in the Consistency Manager.

Reset, Save, Exit

These commands let you either Save the current settings, Reset to the default settings, or to Exit the application without saving the changes.